Skip to content

docs: complete authenticator and authorizer documentation#290

Open
GaneshPatil7517 wants to merge 9 commits intoapache:mainfrom
GaneshPatil7517:docs-fill-authenticator-authorizer
Open

docs: complete authenticator and authorizer documentation#290
GaneshPatil7517 wants to merge 9 commits intoapache:mainfrom
GaneshPatil7517:docs-fill-authenticator-authorizer

Conversation

@GaneshPatil7517
Copy link
Contributor

This PR replaces placeholder TODO pages with complete documentation for the Authenticator and Authorizer components in Apache Shiro.

These are core Shiro components responsible for:

  • Authenticator: Verifying user identity through credential validation
  • Authorizer: Determining user access permissions and roles

The documentation explains their roles in the SecurityManager architecture, how they coordinate with Realms, configuration options, and their purpose in the overall Shiro security framework.

Resolves #283

Copilot AI review requested due to automatic review settings February 6, 2026 03:43
@GaneshPatil7517 GaneshPatil7517 force-pushed the docs-fill-authenticator-authorizer branch from 993f570 to c911576 Compare February 6, 2026 04:04
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR completes the documentation for two core Apache Shiro components (Authenticator and Authorizer) that were previously marked as TODO placeholders. The documentation explains how these components fit into Shiro's architecture, their interaction with Realms, and configuration options. Additionally, the PR modernizes community support references by migrating from JIRA to GitHub Issues and adding GitHub Discussions.

Changes:

  • Added comprehensive documentation for the Authenticator component, explaining its role in verifying user identity and coordinating with Realms during authentication
  • Added comprehensive documentation for the Authorizer component, explaining its role in access control decisions and permission evaluation
  • Updated community support pages to reference GitHub Issues instead of JIRA and added GitHub Discussions as a support channel

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
src/site/content/authenticator.adoc Complete documentation replacing TODO placeholder, covering Authenticator's role, ModularRealmAuthenticator, authentication strategies, and Realm interaction
src/site/content/authorizer.adoc Complete documentation replacing TODO placeholder, covering Authorizer's role, ModularRealmAuthorizer, permission/role checks, and multi-realm authorization
src/site/content/issues.adoc Updated to reference GitHub Issues as the primary issue tracking system, with JIRA marked as legacy/archival
src/site/content/forums.adoc Restructured to emphasize mailing lists per ASF guidelines and added GitHub Discussions as a community forum option
src/site/content/community.adoc Updated forum and issue tracker references to GitHub Discussions and GitHub Issues
src/site/content/mailing-lists.adoc Simplified reference from "Shiro Issues/JIRA List" to "Shiro Issues List"

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Contributor

@lprimak lprimak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job!
One change needed... the new guides are not linked anywhere on the site

@GaneshPatil7517
Copy link
Contributor Author

ok ill work on that give me some time...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Incomplete Documentation Pages

3 participants